Skip to content

docs: add Architecture Decision Records (ADR-001 through ADR-006)#862

Merged
zeevdr merged 3 commits into
mainfrom
docs/6-architecture-decision-records
Jun 4, 2026
Merged

docs: add Architecture Decision Records (ADR-001 through ADR-006)#862
zeevdr merged 3 commits into
mainfrom
docs/6-architecture-decision-records

Conversation

@zeevdr
Copy link
Copy Markdown
Member

@zeevdr zeevdr commented Jun 4, 2026

Summary

  • Key architectural decisions were implicit in code comments and commit history, making onboarding and contribution harder.
  • Added 6 ADRs covering the decisions with the most long-term impact: gRPC over REST, specs-first workflow, PostgreSQL + Redis architecture, metadata-headers-first auth, multi-tenant RLS, and the Go module split.
  • Added a README index at docs/adr/ and a template for future ADRs.

Test plan

  • All ADR files are valid Markdown
  • Index links resolve correctly
  • Content matches actual implementation (spot-check against CLAUDE.md)

Closes #6

@zeevdr zeevdr added docs Documentation size: M Moderate — a day or two, clear scope priority: P2 Nice-to-have labels Jun 4, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 4, 2026

Codecov Report

❌ Patch coverage is 65.90909% with 15 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
sdk/tools/validate/validate.go 65.90% 10 Missing and 5 partials ⚠️

📢 Thoughts on this report? Let us know!

@zeevdr zeevdr force-pushed the docs/6-architecture-decision-records branch from 3e5da41 to 3dc7cc2 Compare June 4, 2026 21:51
@zeevdr zeevdr merged commit 6d0a18f into main Jun 4, 2026
19 checks passed
@zeevdr zeevdr deleted the docs/6-architecture-decision-records branch June 4, 2026 21:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation priority: P2 Nice-to-have size: M Moderate — a day or two, clear scope

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Architecture Decision Records (ADRs)

1 participant